# 接口文档

## 文档目录

1. <a href='#zong'>综述</a>
2. <a href="#all">无需身份验证接口</a>
3. <a href="#auth">需要权限验证接口</a>

<a id="zong"></a>

## 综述

1. 接口权限验证采用 session
2. 接口域名 将下面内容复制到 host 文件中 所有接口都需加此域名为前缀
   > 服务器 ip 地址 服务器域名
3. 接口风格为 restful

   | 请求方式 | 对应操作 |
   | -------- | -------- |
   | GET      | 查询     |
   | POST     | 新增数据 |
   | PUT      | 修改数据 |
   | DELETE   | 删除数据 |

4. 接口实例 (以地址接口为例)

   | 接口地址             | 请求方式 | 对应操作         |
   | -------------------- | -------- | ---------------- |
   | module/className     | GET      | 可分页多条件查询 |
   | module/className/:id | GET      | 查询某条数据     |
   | module/classNam      | POST     | 新增数据         |
   | module/classNam/:id  | PUT      | 修改数据         |
   | module/classNam/:id  | DELETE   | 删除数据         |

   > 备注: :id 表示当前对象的主键

5. 错误信息

```
  {
    "code": 400,
    "error": "操作失败的提示信息"
  }
```

5. 正确信息

```
  {
    "code": 200,
    "data": "操作成功的提示信息"
  }
```

6. 返回数据集

```
  {
    "code": 200,  
    "data": {
      "list": [
          {
            "field": "value",
          },
          {
            "field": "value",
          }
      ],
      "dataCount": 2
    }
  }
```

7. 字段解释

   | 字段      | 类型   | 解释                                                      |
   | --------- | ------ | --------------------------------------------------------- |
   | code      | int    | 状态码 200 为正常 400 为异常                              |
   | type      | int    | 当前接口异常类型 当前接口的 n 类异常信息 用作判断默认为 1 |
   | error     | string | 错误信息                                                  |
   | data      | mixed  | 数据或者成功的提示信息                                    |
   | list      | array  | 数据集                                                    |
   | dataCount | int    | 当前查询条件下 不分页的数据总量                           |

8. 通用请求参数(对应 GET 请求)

   | 字段  | 类型 | 解释                 |
   | ----- | ---- | -------------------- |
   | limit | int  | 单页数据量 (默认 20) |
   | page  | int  | 当前页码 (默认为 1)  |

<a id="all"></a>

### 无需身份验证接口

---

<a id='auth'></a>

### 需要权限验证的接口
